home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / snarf102.zip / SNARF.DOC < prev    next >
Text File  |  1991-04-20  |  10KB  |  227 lines

  1.  
  2.  
  3.             Snarf v1.02, copyright 1990, 1991 by Graham Mainwaring.
  4.                              All rights reserved.
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11. INSTALLATION
  12.  
  13.  
  14. To install Snarf, simply place SNARF.EXE in a directory somewhere
  15. convenient, such as a utilities or communications directory.  In addition,
  16. make sure you have a copy of DSZ from Omen Technologies somewhere in your
  17. DOS search path.  Snarf is now installed and ready to run.  However, for best
  18. results, you will probably want to configure some of Snarf's options to match
  19. your system and preferences.  The next section will tell you how to do this.
  20.  
  21.  
  22.  
  23.  
  24. CONFIGURATION
  25.  
  26.  
  27. To configure Snarf, run the command "SNARF CONFIG".  This will bring up a
  28. screen of options.  Use the up and down cursor keys, or the tab and
  29. shift-tab keys, to move between options.  Use the left and right cursor keys
  30. to move within an option.  The meanings of the individual options follow.
  31.  
  32. COM Port Option Group:
  33.    COM Port Number
  34.       Hardware Port
  35.       Hardware Interrupt
  36.    Baud Rate
  37.    Fixed Baud Rate
  38.  
  39. The first group of options deals with the basic configuration of your modem
  40. port.  If your modem is at a standard address like COM1 or COM2, you can
  41. just set the value "COM Port Number", and the two hardware settings will
  42. automatically change to the appropriate values.  If your modem is at an
  43. unusual address, you can set the hardware port address and interrupt line.
  44. If you set the hardware options so that they correspond with a standard
  45. address, the COM port number field will automatically change to show the
  46. address you have chosen.
  47.  
  48. The other options in the first group concern the baud rate.  If you have a
  49. high-speed or MNP modem which uses a fixed DTE speed to communicate with the
  50. computer, you should set "fixed baud rate" to yes, and set the baud rate
  51. field to the speed your modem uses.  If you have a regular modem, you
  52. should set "fixed baud rate" to no, and set the baud rate to the highest
  53. speed your modem supports.  When Snarf is not told to use a fixed baud rate,
  54. it uses the connect messages from the modem to determine what speed to use
  55. with the remote computer.
  56.  
  57. Modem Option Group:
  58.    Modem initialization
  59.    Modem dial prefix
  60.    Modem connect result
  61.  
  62. This group of options deals with modem configuration.  Snarf automatically
  63. operates so as to work with all fully Hayes-compatible modems. However, many
  64. modems have extensions and changes to the original standards, and if you
  65. have such a modem you will need to tell Snarf how to initialize it.  The
  66. modem initialization string is usually blank, but if it is filled in with a
  67. command, the command will be sent immediately following Snarf's default
  68. initialization.  Snarf's default initialization sends the following
  69. commands:
  70.  
  71.    &C1   - On most newer modems, sets DCD to follow actual carrier.
  72.    &D2   - On most newer modems, sets DTR processing active.
  73.    X4    - Most modems detect a busy signal correctly at this setting.
  74.    V1    - Verbose result codes.  Snarf does not work with numeric results.
  75.    M1    - Speaker on.
  76.    S2=43 - Sets escape character to the standard + sign.
  77.  
  78. Snarf understands that some of these commands may not be recognized by the
  79. modem.  For example, &C1 and &D2 are only applicable to newer modems, and
  80. are generally not valid on older ones.  Snarf will recognize the error
  81. result from the modem correctly, and set the other parameters anyway.
  82.  
  83. These values are designed to provide good results on the widest variety of
  84. modems possible.  However, if your modem requires additional parameters for
  85. initialization, or especially if some of these parameters are incorrect, you
  86. can use the initialization field to override the default values and
  87. correctly reset the modem.
  88.  
  89. The modem dial prefix is generally left the way it is, unless your phone
  90. system requires pulse dialing or you want a global prefix (dial 9 to get
  91. out, for example).  In addition, some not-totally-compatible modems use
  92. different commands for dialing.
  93.  
  94. The connect result should almost never need to be changed.  The reason it is
  95. in here is that a friend of mine has a modem which is 100% Hayes-compatible
  96. in all respects other than that it says "Accept" instead of "CONNECT" when
  97. it makes a connection.  There should be no reason to change this field if
  98. your modem is not peculiar.
  99.  
  100.  
  101. DSZ Option Group:
  102.    Make DSZ invisible
  103.    DSZ send command line
  104.    DSZ receive command line
  105.  
  106. These options control how the DSZ protocol driver is accessed.  The send and
  107. receive command lines are simply the commands to be given to DSZ when you
  108. want to send or receive a file.  There is no need to worry about port,
  109. speed, or filename parameters, as these are handled automatically by Snarf.
  110. The purpose of these options is to allow you to configure DSZ to use
  111. Compressed, CRC-32, Moby Turbo, Crash Recovery, or other such options.
  112. Details of DSZ command-line settings can be found in the documentation
  113. accompanying DSZ.
  114.  
  115. The "Make DSZ Invisible" option is for people who don't like a lot of
  116. clutter on their screens.  Once you have tried a few downloads and verified
  117. that Snarf is working correctly, you can turn this option on, and the output
  118. messages from DSZ will be removed from the screen.  The disadvantage is that
  119. without the DSZ messages, you don't know how much longer the transfer is
  120. going to take.  Needless to say, this option is entirely a matter of
  121. personal preference.
  122.  
  123.  
  124. User Option Group
  125.    User identification
  126.    Directory for downloads
  127.  
  128. The "User Identification" field in this group lets you send a message to
  129. BBSes you snarf from telling them who you are.  Sysops like to know who's
  130. downloading their files, and it is generally polite to put at least
  131. something in here.  If you have a network e-mail address, it would be
  132. appropriate here as well.  The "Directory For Downloads" field simply sets
  133. the directory in which received files will be placed.  If it is left blank,
  134. received files will be placed in the current directory.
  135.  
  136.  
  137.  
  138.  
  139. USING SNARF
  140.  
  141.  
  142. The Snarf command-line is fairly simple.  The first parameter is the phone
  143. number of the BBS you want to call, and the rest of the command line is a
  144. list of files to download.  In addition, there are a few other parameters
  145. you can use.  To upload a file instead of downloading it, put a ^ in front
  146. of the filename.  To download the master file listing from the BBS, put a *
  147. by itself.  Here is a sample command line:
  148.  
  149.    C> snarf 1-919-876-7213 latest.zip * ^comments.txt
  150.  
  151. This command causes Snarf to dial the given phone number, download the file
  152. latest.zip, then download the master file list, and then upload the file
  153. comments.zip.
  154.  
  155. Another way to specify Snarf commands is to use a list file.  This is
  156. especially useful when downloading large numbers of files.  To use a list
  157. file, place Snarf command-line arguments in a text file, one to each line.
  158. Then run Snarf, and give the list file as a parameter, with a @ in front of
  159. it.  For example, if the text file COMMANDS.TXT contained the following:
  160.  
  161.    latest.zip
  162.    *
  163.    ^comments.zip
  164.  
  165. And if you issued the Snarf command:
  166.  
  167.    C> snarf 1-919-876-7213 @commands.txt
  168.  
  169. The result would be exactly the same as the other example.  You can mix list
  170. files with regular commands on the Snarf command line, and issue as many
  171. commands as you want.  The primary reason to use list files instead of long
  172. command lines is that DOS can only accept 127 characters of command at a
  173. time, so if you are downloading more than about twelve 4{&lolzkkt%lorks, DOS
  174. will not allow you to type ÿhem all in a single command.
  175.  
  176. In case you don't want to remember the phone number of every system you
  177. call, Snarf will let you specify a BBS by name instead of number.  To
  178. activate this feature, create a text file called PHONE.TXT in the same
  179. directory as SNARF.EXE.  For each BBS you call, create a line in the file
  180. with the name you want to use on the command line, one or more spaces, and
  181. the phone number.  It is important not to put any spaces before the name of
  182. the BBS, or inside the name or phone number.  Here is a sample PHONE.TXT
  183. file:
  184.  
  185.    octopus   1-919-876-7213     The Octopus's Garden, home of Snarf
  186.    graces    1-919-831-2759     Social Graces, Snarfable WWIV support board
  187.    dragons   1-512-631-5841     Dragon's Den, Snarfable WWIV support board
  188.  
  189. If you were using this file, you could issue the command:
  190.  
  191.    C> snarf dragons wwiv412.zip net23.zip *
  192.  
  193. This would call the Dragon's Den at the number listed in the file, download
  194. WWIV412.ZIP and NET23.ZIP, and download the master file list.
  195.  
  196.  
  197.  
  198.  
  199. QUESTIONS AND BUGS
  200.  
  201. Should you have any questions concerning Snarf, or should you discover a bug
  202. and wish to report it, please send WWIVnet e-mail to 1@9970.  If you do not
  203. have access to WWIVnet, please use paper mail to the address listed in the
  204. registration section.  While I try to answer all my mail, I will strongly
  205. favor registered users for any time-consuming problem solving.
  206.  
  207.  
  208.  
  209.  
  210. REGISTRATION
  211.  
  212. If you find Snarf useful, you are encouraged to become a registered user.
  213. The cost to register is $25.  When you register, you will be sent a disk
  214. containing the current version of Snarf.  At your option, you may request
  215. that the disk not be sent until a new version is available.  When new
  216. versions are released, registered users will be given the option to receive
  217. the new version on disk for a $5 postage and handling charge.  Remember to
  218. include your phone number in case of a problem.  Please make checks payable
  219. to Graham Mainwaring.  It is unwise to send cash through the mail. North
  220. Carolina residents please add 5% sales tax.  All correspondence should be
  221. addressed to:
  222.  
  223. Graham Mainwaring
  224. P.O. Box 17288
  225. Raleigh, NC 27619
  226.  
  227.